Add markdownlint workflow #693
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a markdownlint configuration and workflow to enforce consistent markdown style.
It touches a lot of files because it also brings our existing markdown into compliance with the linter as configured.
CoPilot Summary
This pull request includes several updates to Markdown linting workflows, configuration, and various Markdown files to improve consistency and readability. The most important changes include the addition of a GitHub Actions workflow for linting Markdown files, updates to the Markdown linting configuration, and numerous formatting adjustments across multiple Markdown files.
Workflow and Configuration Updates:
.github/workflows/lint_md_changes.yml..markdownlint.ymlconfiguration to disable certain noisy rules and enforce specific styles for unordered lists and emphasis.Formatting Adjustments:
README.md,docs/_includes/helping_out.md, anddocs/about/changelog.mdto align with the updated linting rules. [1] [2] [3]README.mdfor better Markdown compliance. [1] [2] [3]These changes enhance the project's Markdown documentation quality and ensure consistency across the repository.